Ait 129 ait docs release branch #3040

mschristensen · 2025-12-17T16:48:23Z

Description

AIT DOCS INTEGRATION BRANCH

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2025-12-17T16:48:30Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

src/pages/docs/ai-transport/features/token-streaming/message-per-response.mdx

paddybyers · 2025-12-19T10:58:23Z

src/pages/docs/ai-transport/token-streaming/message-per-response.mdx

+```
+</Code>
+
+When publishing tokens, don't await the `channel.appendMessage()` call. Ably rolls up acknowledgments and debounces them for efficiency, which means awaiting each append would unnecessarily slow down your token stream. Messages are still published in the order that `appendMessage()` is called, so delivery order is not affected.


How do we suggest that clients check for the success or failure of the publish?

I have created a separate ticket to address this: https://ably.atlassian.net/browse/AIT-238

src/pages/docs/ai-transport/features/token-streaming/message-per-response.mdx

src/pages/docs/ai-transport/token-streaming/message-per-response.mdx

src/pages/docs/ai-transport/features/token-streaming/message-per-token.mdx

rainbowFi · 2026-01-05T11:25:21Z

src/pages/docs/ai-transport/token-streaming/message-per-token.mdx

+
+This pattern is useful when clients only care about the most recent part of a response and you are happy to treat the channel history as a short sliding window rather than a full conversation log. For example:
+
+- **Backend-stored responses**: The backend writes complete responses to a database and clients load those full responses from there, while Ably is used only to deliver live tokens for the current in-progress response.


I don't think we want to promote using this pattern with backend-stored responses, because the backend storage solves the efficient hydration problem but does not solve the problem of missing tokens for the current response (assuming the response is not written to the database until it has been completely streamed, which is the pattern most existing customers are using and struggling with). It would be simpler for a customers to load history from their own database and then use message-per-response to catch up with any in-progress response

src/pages/docs/ai-transport/token-streaming/message-per-response.mdx

Details the message-per-response pattern using Ably `appendMessage` for Anthropic SDK.

Adds a page to the Messaging section that describes sending tool calls and results to users over channels. Indicates ability to build generative user interfaces or implement human in the loop workflows.

Remove /features/ path segment from AI Transport documentation URLs: - /ai-transport/features/messaging/* → /ai-transport/messaging/* - /ai-transport/features/token-streaming/* → /ai-transport/token-streaming/* - /ai-transport/features/sessions-identity/* → /ai-transport/sessions-identity/* Update navigation and internal links in guides accordingly.

Adds a token streaming rate limits page which includes description of the new appendRollupWindow transport parameter.

For high volume token streaming uses cases, we generally advise disabling `echoMessages` to avoid incurring additional cost from echoed messages.

Prevent multiple agent(and Realtime) .

Adds additional friendly guidance to the writing style guide to stop LLMs consuming it from falling back onto bad habits.

Add information about pricing to the overview page and include a worked example for illustration

paddybyers

lgtm

mschristensen added the review-app Create a Heroku review app label Dec 17, 2025

paddybyers reviewed Dec 19, 2025

View reviewed changes

matt423 force-pushed the AIT-129-AIT-Docs-release-branch branch from 400eb09 to f8056cb Compare December 23, 2025 10:41

matt423 added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Dec 23, 2025

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-5wu2wt December 23, 2025 10:48 Inactive

rainbowFi reviewed Jan 5, 2026

View reviewed changes

mschristensen mentioned this pull request Jan 5, 2026

Bugfix/ait 129 misc feedback #3070

Merged

3 tasks

matt423 added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Jan 7, 2026

mschristensen force-pushed the AIT-129-AIT-Docs-release-branch branch from aebe2c1 to ea0ac8d Compare January 7, 2026 11:48

mschristensen added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Jan 8, 2026

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 8, 2026 14:23 Inactive

ably-ci had a problem deploying to ably-docs-ait-129-ait-d-usn5rq January 12, 2026 14:26 Failure

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 12, 2026 15:54 Inactive

GregHolmes temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 13, 2026 12:48 Inactive

GregHolmes temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 13, 2026 16:18 Inactive

matt423 temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 13, 2026 17:16 Inactive

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 14, 2026 11:28 Inactive

matt423 temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 14, 2026 13:08 Inactive

matt423 temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 14, 2026 15:41 Inactive

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 14, 2026 17:36 Inactive

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 15, 2026 10:16 Inactive

mschristensen force-pushed the AIT-129-AIT-Docs-release-branch branch from 7821a8f to 426203f Compare January 15, 2026 10:26

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 15, 2026 10:26 Inactive

VeskeR reviewed Jan 15, 2026

View reviewed changes

src/pages/docs/ai-transport/token-streaming/message-per-response.mdx Outdated Show resolved Hide resolved

GregHolmes temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 16, 2026 12:33 Inactive

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 16, 2026 14:11 Inactive

matt423 and others added 12 commits January 16, 2026 16:49

feat: Add guide for Anthropic SDK message-per-response streaming

5274a72

Details the message-per-response pattern using Ably `appendMessage` for Anthropic SDK.

chore: Add async/await for processEvent in OpenAI guide

7868abe

ait/features: add tool call page

2d3dab0

Adds a page to the Messaging section that describes sending tool calls and results to users over channels. Indicates ability to build generative user interfaces or implement human in the loop workflows.

ait/features: misc. fixes to citations docs

e4ebb87

Add an overview page for AI Transport

0e46617

ait/features: token streaming rate limits

43708ba

Adds a token streaming rate limits page which includes description of the new appendRollupWindow transport parameter.

ait: advise disabling echo

45ac85a

For high volume token streaming uses cases, we generally advise disabling `echoMessages` to avoid incurring additional cost from echoed messages.

chore: Use 2.17.0 in examples

208d73d

feat: Add AI Transport message per response example for Javascript

a0dbcdc

feat: Add AI Transport message per response example for React

0449aee

chore: Use single agent reference in AIT examples

01ab0f8

Prevent multiple agent(and Realtime) .

mschristensen force-pushed the AIT-129-AIT-Docs-release-branch branch from 20df5cb to 01ab0f8 Compare January 16, 2026 16:50

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 16, 2026 16:50 Inactive

mschristensen added 2 commits January 16, 2026 16:58

docs: writing style guide

6fa00a7

Adds additional friendly guidance to the writing style guide to stop LLMs consuming it from falling back onto bad habits.

ait: misc improvements

1847a6b

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 16, 2026 16:59 Inactive

AIT-149: Add pricing information to docs (#3106)

42916b2

Add information about pricing to the overview page and include a worked example for illustration

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 16, 2026 17:04 Inactive

mschristensen marked this pull request as ready for review January 16, 2026 17:06

mschristensen requested review from paddybyers and rainbowFi January 16, 2026 17:16

paddybyers approved these changes Jan 16, 2026

View reviewed changes

ait: fix appendMessage signature

6c6f490

ably-ci deployed to ably-docs-ait-129-ait-d-usn5rq January 16, 2026 17:20 View deployment

mschristensen enabled auto-merge (rebase) January 16, 2026 17:21

Fixup: faulty link

b1947da

ably-ci temporarily deployed to ably-docs-ait-129-ait-d-usn5rq January 16, 2026 17:41 Inactive

mschristensen merged commit b5a5b08 into main Jan 16, 2026
7 checks passed

mschristensen deleted the AIT-129-AIT-Docs-release-branch branch January 16, 2026 17:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Ait 129 ait docs release branch #3040

Ait 129 ait docs release branch #3040

Uh oh!

mschristensen commented Dec 17, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 17, 2025 •

edited

Loading

Review skipped

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

paddybyers Dec 19, 2025

Uh oh!

mschristensen Jan 5, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rainbowFi Jan 5, 2026

Uh oh!

Uh oh!

paddybyers left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

13 participants


		This pattern is useful when clients only care about the most recent part of a response and you are happy to treat the channel history as a short sliding window rather than a full conversation log. For example:

		- Backend-stored responses: The backend writes complete responses to a database and clients load those full responses from there, while Ably is used only to deliver live tokens for the current in-progress response.

Ait 129 ait docs release branch #3040

Ait 129 ait docs release branch #3040

Uh oh!

Conversation

mschristensen commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

coderabbitai bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

paddybyers Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

mschristensen Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rainbowFi Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

paddybyers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

13 participants

mschristensen commented Dec 17, 2025 •

edited

Loading

coderabbitai bot commented Dec 17, 2025 •

edited

Loading